/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2009-2013 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://github.com/payara/Payara/blob/main/LICENSE.txt
 * See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at legal/OPEN-SOURCE-LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.grizzly.config.dom;

import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.ConfigBeanProxy;
import org.jvnet.hk2.config.Configured;
import org.jvnet.hk2.config.types.PropertyBag;

/**
 * Created Jan 8, 2009
 *
 * @author <a href="mailto:justin.d.lee@oracle.com">Justin Lee</a>
 */
@Configured
public interface FileCache extends ConfigBeanProxy, PropertyBag {
    boolean ENABLED = false;
    int MAX_AGE = 30;
    int MAX_CACHE_SIZE = 10485760;
    int MAX_FILES = 1024;

    /**
     * Enables the caching of file content
     */
    @Attribute(defaultValue = "" + ENABLED, dataType = Boolean.class)
    String getEnabled();

    void setEnabled(final String enabled);

    /**
     * How old files can get before aging out of cache in seconds
     */
    @Attribute(defaultValue = "" + MAX_AGE, dataType = Integer.class)
    String getMaxAgeSeconds();

    void setMaxAgeSeconds(final String maxAge);

    /**
     * Maximum cache size on the disk
     */
    @Attribute(defaultValue = "" + MAX_CACHE_SIZE, dataType = Integer.class)
    String getMaxCacheSizeBytes();

    void setMaxCacheSizeBytes(final String maxCacheSize);

    /**
     * Maximum number of files in the file cache.
     */
    @Attribute(defaultValue = "" + MAX_FILES, dataType = Integer.class)
    String getMaxFilesCount();

    void setMaxFilesCount(final String maxFilesCount);
}
